.TH E1432_GET_CURRENT_VALUE 3 E1432
.SH NAME
e1432_get_current_value \- Get current Peak value, RMS value, or FIFO
available count
.IX e1432_get_current_value(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_get_current_value(E1432ID hw, SHORTSIZ16 ID,
                                   SHORTSIZ16 value_type,
                                   FLOATSIZ32 *value)
.cE
.SH DESCRIPTION

\fIe1432_get_current_value\fR gets the Peak or RMS current value for of a
single channel or group of channels \fIID\fR.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is the channel number of a channel that has been assigned to a
group using \fIe1432_create_channel_group\fR.

The \fIvalue_type\fR should be one of:
.IP \fBE1432_CURRENT_VAL_PEAK\fR, 7
indicating that the current Peak value is to be returned.
.IP \fBE1432_CURRENT_VAL_RMS\fR, 7
indicating that the current RMS value is to be returned.
.IP \fBE1432_CURRENT_VAL_FIFO_AVAIL\fR, 7
indicating that the current amount of data in the FIFO is to be
returned.
.PP

\fIvalue\fR is a pointer to a single floating point variable in the case
of a single channel \fIID\fR, or a pointer to an array of floating point
variables large enough to accept one current value result for each of 
the channels in channel group \fIID\fR.

When \fIvalue\fR is \fBE1432_CURRENT_VAL_PEAK\fR or
\fBE1432_CURRENT_VAL_RMS\fR, if a channel is not enabled or if the
requested value computation has not been enabled with
\fIe1432_set_peak_mode\fR or \fIe1432_set_rms_mode\fR, 0 will be
returned in the corresponding \fIvalue\fR.

The functions \fIe1432_set_peak_decay_time\fR,
\fIe1432_set_rms_avg_time\fR, and \fIe1432_set_rms_decay_time\fR
control the time responses of the peak and RMS current values.

The weighting, selected by \fIe1432_set_weighting\fR, is applied to
the peak and RMS current values.

The \fBE1432_CURRENT_VAL_PEAK\fR or \fBE1432_CURRENT_VAL_RMS\fR values
are currently available only with the E1433.
\fBE1432_CURRENT_VAL_FIFO_AVAIL\fR works for both the E1432 and E1433.

.SH "RESET VALUE"
After a reset, Peak and RMS value computation is not enabled, and the
FIFO is not running, so \fIe1432_get_current_value\fR will only return
zero valued results.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_peak_mode, e1432_set_rms_mode,
e1432_set_peak_decay_time, e1432_set_rms_avg_time, e1432_set_rms_decay_time,
e1432_set_weighting.
.ad
